Purview Workflow Service (preview:2022-05-01)

2025/12/05 • 14 new methods

ListWorkflows (new)
Description :  List all workflows.
Reference :  Link ¶

⚼ Request

GET:  /workflows
{
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value of workflow list. ,
Required: True ,
}
[
{
id:
{
Description: The id of workflow. ,
Format: uuid ,
Required: True ,
}
string ,
triggers:
{
Description: It describes under what condition a workflow will run. ,
Required: True ,
}
[
{
type:
{
Enum:
{
when_term_creation_is_requested: No description available. ,
when_term_deletion_is_requested: No description available. ,
when_term_update_is_requested: No description available. ,
when_terms_import_is_requested: No description available. ,
when_data_access_grant_is_requested: No description available. ,
when_asset_update_is_requested: No description available. ,
}
,
Required: True ,
}
enum ,
underGlossaryHierarchy:
{
Description: Glossary term hierarchy path. ,
Required: False ,
}
string ,
underCollection:
{
Description: The collection name. ,
Required: False ,
}
string ,
underGlossary:
{
Description: The glossary guid. ,
Required: False ,
}
string ,
}
,
]
,
createdTime:
{
Description: The created time of workflow. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The person who created the workflow. ,
Required: False ,
}
string ,
lastUpdateTime:
{
Description: The last update time. ,
Format: date-time ,
Required: False ,
}
string ,
updatedBy:
{
Description: The person who updated the workflow. ,
Required: False ,
}
string ,
name:
{
Description: The name of a workflow. ,
Required: True ,
}
string ,
isEnabled:
{
Description: Whether the workflow is enabled or not. ,
Required: True ,
}
boolean ,
description:
{
Description: Description of a workflow. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: True ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: True ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: True ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
GetWorkflow (new)
Description :  Get a specific workflow.
Reference :  Link ¶

⚼ Request

GET:  /workflows/{workflowId}
{
workflowId:
{
Description: The workflow id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: The workflow properties. It includes the triggers, actual flow and other properties of a workflow. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: True ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: True ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: True ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
CreateOrReplaceWorkflow (new)
Description :  Create or replace a workflow.
Reference :  Link ¶

⚼ Request

PUT:  /workflows/{workflowId}
{
workflowId:
{
Description: The workflow id. ,
Format: uuid ,
Required: True ,
}
string ,
workflowCreateOrUpdateCommand:
{
Description: Create or update workflow payload. ,
Required: True ,
}
{
triggers:
{
Description: It describes under what condition a workflow will run. ,
Required: True ,
}
[
{
type:
{
Enum:
{
when_term_creation_is_requested: No description available. ,
when_term_deletion_is_requested: No description available. ,
when_term_update_is_requested: No description available. ,
when_terms_import_is_requested: No description available. ,
when_data_access_grant_is_requested: No description available. ,
when_asset_update_is_requested: No description available. ,
}
,
Required: True ,
}
enum ,
underGlossaryHierarchy:
{
Description: Glossary term hierarchy path. ,
Required: False ,
}
string ,
underCollection:
{
Description: The collection name. ,
Required: False ,
}
string ,
underGlossary:
{
Description: The glossary guid. ,
Required: False ,
}
string ,
}
,
]
,
name:
{
Description: The workflow name. ,
Required: True ,
}
string ,
isEnabled:
{
Description: Whether the workflow enabled or not. ,
Required: True ,
}
boolean ,
description:
{
Description: Description of a workflow. ,
Required: True ,
}
string ,
actionDag:
{
Description: The action DAG(Directed Acyclic Graph), it defines actual flow. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: The workflow properties. It includes the triggers, actual flow and other properties of a workflow. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: True ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: True ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: True ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
DeleteWorkflow (new)
Description :  Delete a workflow.
Reference :  Link ¶

⚼ Request

DELETE:  /workflows/{workflowId}
{
workflowId:
{
Description: The workflow id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: True ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: True ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: True ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
SubmitUserRequests (new)
Description :  Submit a user request for requestor, a user request describes user ask to do operation(s) on Purview. If any workflow's trigger matches with an operation in request, a run of the workflow is created.
Reference :  Link ¶

⚼ Request

POST:  /userrequests
{
userRequestsPayload:
{
Description: The payload of submitting a user request. ,
Required: True ,
}
{
operations:
{
Description: The list of operations user want to submit, each operation matches one Purview API call and will do the operation directly. ,
Required: True ,
}
[
{
type:
{
Description: The operation type. ,
Enum:
{
CreateTerm: No description available. ,
UpdateTerm: No description available. ,
DeleteTerm: No description available. ,
ImportTerms: No description available. ,
UpdateAsset: No description available. ,
GrantDataAccess: No description available. ,
}
,
Required: True ,
}
enum ,
payload:
{
Description: The payload of each operation which user want to submit. ,
Required: True ,
}
object ,
}
,
]
,
comment:
{
Description: The comment when submit a user request. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
requestId:
{
Description: The user request id. ,
Format: uuid ,
Required: True ,
}
string ,
requestor:
{
Description: The person who submitted the user request. ,
Format: uuid ,
Required: True ,
}
string ,
operations:
{
Description: The list of operations user want to submit, each operation matches one Purview API call and will do the operation directly. ,
Required: True ,
}
[
{
type:
{
Description: The operation type. ,
Enum:
{
CreateTerm: No description available. ,
UpdateTerm: No description available. ,
DeleteTerm: No description available. ,
ImportTerms: No description available. ,
UpdateAsset: No description available. ,
GrantDataAccess: No description available. ,
}
,
Required: True ,
}
enum ,
payload:
{
Description: The payload of each operation which user want to submit. ,
Required: True ,
}
object ,
workflowRunIds:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
comment:
{
Description: The comment when submit a user request. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
Canceling: No description available. ,
CancellationFailed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: True ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: True ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: True ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
ListWorkflowRuns (new)
Description :  List workflow runs.
Reference :  Link ¶

⚼ Request

GET:  /workflowruns
{
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
timeWindow:
{
Description: Time window of filtering items. ,
Required: False ,
}
string ,
orderby:
{
Description: The key word which used to sort the results. ,
Required: False ,
}
string ,
runStatuses:
{
Description: Filter workflow runs by workflow run status. ,
Required: False ,
}
array ,
workflowIds:
{
Description: Filter items by workflow id list. ,
Required: False ,
}
array ,
maxpagesize:
{
Description: The maximum page size to get the items at one time. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The value of workflow run list. ,
Required: True ,
}
[
{
id:
{
Description: The workflow run id. ,
Format: uuid ,
Required: True ,
}
string ,
workflowId:
{
Description: The workflow id. ,
Format: uuid ,
Required: True ,
}
string ,
startTime:
{
Description: Workflow run start time. ,
Format: date-time ,
Required: True ,
}
string ,
requestor:
{
Description: The person who submitted the user request. ,
Format: uuid ,
Required: True ,
}
string ,
userRequestId:
{
Description: The user request id. ,
Format: uuid ,
Required: False ,
}
string ,
runPayload:
{
Description: The input of a workflow run. Align with operation in user request. ,
Required: True ,
}
{
type:
{
Description: The workflow run payload type. ,
Enum:
{
CreateTerm: No description available. ,
UpdateTerm: No description available. ,
DeleteTerm: No description available. ,
ImportTerms: No description available. ,
UpdateAsset: No description available. ,
GrantDataAccess: No description available. ,
}
,
Required: True ,
}
enum ,
targetValue:
{
Description: The target value which need involve workflow to update. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
Canceling: No description available. ,
CancellationFailed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
endTime:
{
Description: The time of workflow run completed. ,
Format: date-time ,
Required: False ,
}
string ,
cancelTime:
{
Description: The time of workflow run be canceled. ,
Format: date-time ,
Required: False ,
}
string ,
cancelComment:
{
Description: The comment when cancel a workflow run. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: True ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: True ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: True ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
GetWorkflowRun (new)
Description :  Get a workflow run.
Reference :  Link ¶

⚼ Request

GET:  /workflowruns/{workflowRunId}
{
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
workflowRunId:
{
Description: The workflow run id. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The workflow run id. ,
Format: uuid ,
Required: False ,
}
string ,
workflowId:
{
Description: The workflow id. ,
Format: uuid ,
Required: False ,
}
string ,
startTime:
{
Description: Workflow run start time. ,
Format: date-time ,
Required: False ,
}
string ,
requestor:
{
Description: The person who submitted the user request. ,
Format: uuid ,
Required: False ,
}
string ,
userRequestId:
{
Description: The user request id. ,
Format: uuid ,
Required: False ,
}
string ,
runPayload:
{
Description: The input of a workflow run. Align with operation in user request. ,
Required: False ,
}
{
type:
{
Description: The workflow run payload type. ,
Enum:
{
CreateTerm: No description available. ,
UpdateTerm: No description available. ,
DeleteTerm: No description available. ,
ImportTerms: No description available. ,
UpdateAsset: No description available. ,
GrantDataAccess: No description available. ,
}
,
Required: True ,
}
enum ,
targetValue:
{
Description: The target value which need involve workflow to update. ,
Required: True ,
}
string ,
payload:
{
Description: The payload of each operation which user want to submit. ,
Required: True ,
}
object ,
}
,
status:
{
Description: The status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
Canceling: No description available. ,
CancellationFailed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
endTime:
{
Description: The time of workflow run completed. ,
Format: date-time ,
Required: False ,
}
string ,
cancelTime:
{
Description: The time of workflow run be canceled. ,
Format: date-time ,
Required: False ,
}
string ,
cancelComment:
{
Description: The comment when cancel a workflow run. ,
Required: False ,
}
string ,
actionDag:
{
Description: The action DAG(Directed Acyclic Graph), it defines actual flow. ,
Required: True ,
}
object ,
detail:
{
Description: It refers to the "detail" property of a workflow run object, which contains run context and runtime information of actions. ,
Required: True ,
}
{
runInput:
{
Description: Built-in variables starts with @runInput. Its properties are determined by trigger type at workflow run time. ,
Required: True ,
}
object ,
actions:
{
Required: True ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: True ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: True ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: True ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
CancelWorkflowRun (new)
Description :  Cancel a workflow run.
Reference :  Link ¶

⚼ Request

POST:  /workflowruns/{workflowRunId}/cancel
{
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
workflowRunId:
{
Description: The workflow run id. ,
Format: uuid ,
Required: True ,
}
string ,
runCancelReply:
{
Description: Reply of canceling a workflow run. ,
Required: True ,
}
{
comment:
{
Description: The comment of canceling a workflow run. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: True ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: True ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: True ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
ListWorkflowTasks (new)
Description :  Get all workflow tasks.
Reference :  Link ¶

⚼ Request

GET:  /workflowtasks
{
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
viewMode:
{
Description: To filter user's sent, received or history workflow tasks. ,
Required: False ,
}
string ,
workflowIds:
{
Description: Filter items by workflow id list. ,
Required: False ,
}
array ,
timeWindow:
{
Description: Time window of filtering items. ,
Required: False ,
}
string ,
maxpagesize:
{
Description: The maximum page size to get the items at one time. ,
Format: int32 ,
Required: False ,
}
integer ,
orderby:
{
Description: The key word which used to sort the results. ,
Required: False ,
}
string ,
taskTypes:
{
Description: Filter items by workflow task type. ,
Required: False ,
}
array ,
taskStatuses:
{
Description: Filter workflow tasks by status. ,
Required: False ,
}
array ,
workflowNameKeyword:
{
Description: The key word which could used to filter workflow item with related workflow. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value of workflow tasks list. ,
Required: True ,
}
[
{
type:
{
Description: The workflow task type. ,
Enum:
{
Approval: No description available. ,
SimpleTask: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: The workflow task id. ,
Format: uuid ,
Required: True ,
}
string ,
title:
{
Description: The workflow task title. ,
Required: False ,
}
string ,
workflowRunId:
{
Description: The workflow run id. ,
Format: uuid ,
Required: True ,
}
string ,
workflowId:
{
Description: The workflow id. ,
Format: uuid ,
Required: True ,
}
string ,
requestor:
{
Description: The person who submitted the user request. ,
Format: uuid ,
Required: True ,
}
string ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdateTime:
{
Description: The last update time. ,
Format: date-time ,
Required: True ,
}
string ,
payload:
{
Description: Info and material that helps assignees to take action. ,
Required: True ,
}
{
type:
{
Description: The task payload type. ,
Enum:
{
CreateTerm: No description available. ,
UpdateTerm: No description available. ,
DeleteTerm: No description available. ,
ImportTerms: No description available. ,
UpdateAsset: No description available. ,
GrantDataAccess: No description available. ,
}
,
Required: True ,
}
enum ,
targetValue:
{
Description: The target value of entity which user want to involve workflow to update. ,
Required: True ,
}
string ,
payload:
{
Description: The payload of the task. ,
Required: False ,
}
object ,
}
,
reminderInfo:
{
Description: Info of task reminder. ,
Required: False ,
}
{
lastRemindTime:
{
Description: The last update time. ,
Format: date-time ,
Required: False ,
}
string ,
nextRemindTime:
{
Description: The next remind time. ,
Format: date-time ,
Required: True ,
}
string ,
reminderSettings:
{
Description: The reminder settings. ,
Required: True ,
}
object ,
}
,
expiryInfo:
{
Description: Info of task expiry. ,
Required: False ,
}
{
lastExpiryNotificationTime:
{
Description: The last expiry notification time. ,
Format: date-time ,
Required: False ,
}
string ,
nextExpiryNotificationTime:
{
Description: The next expiry notification time. ,
Format: date-time ,
Required: True ,
}
string ,
expiryTime:
{
Description: The expiry time. ,
Format: date-time ,
Required: True ,
}
string ,
expirySettings:
{
Required: True ,
}
{
expireAfter:
{
Description: The time of expiry. ,
Required: True ,
}
object ,
notifyOnExpiration:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: True ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: True ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: True ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
GetWorkflowTask (new)
Description :  Get a workflow task.
Reference :  Link ¶

⚼ Request

GET:  /workflowtasks/{taskId}
{
taskId:
{
Description: The task id. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: The workflow task type. ,
Enum:
{
Approval: No description available. ,
SimpleTask: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: The workflow task id. ,
Format: uuid ,
Required: True ,
}
string ,
title:
{
Description: The workflow task title. ,
Required: False ,
}
string ,
workflowRunId:
{
Description: The workflow run id. ,
Format: uuid ,
Required: True ,
}
string ,
workflowId:
{
Description: The workflow id. ,
Format: uuid ,
Required: True ,
}
string ,
requestor:
{
Description: The person who submitted the user request. ,
Format: uuid ,
Required: True ,
}
string ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdateTime:
{
Description: The last update time. ,
Format: date-time ,
Required: True ,
}
string ,
payload:
{
Description: Info and material that helps assignees to take action. ,
Required: True ,
}
{
type:
{
Description: The task payload type. ,
Enum:
{
CreateTerm: No description available. ,
UpdateTerm: No description available. ,
DeleteTerm: No description available. ,
ImportTerms: No description available. ,
UpdateAsset: No description available. ,
GrantDataAccess: No description available. ,
}
,
Required: True ,
}
enum ,
targetValue:
{
Description: The target value of entity which user want to involve workflow to update. ,
Required: True ,
}
string ,
payload:
{
Description: The payload of the task. ,
Required: False ,
}
object ,
}
,
reminderInfo:
{
Description: Info of task reminder. ,
Required: False ,
}
{
lastRemindTime:
{
Description: The last update time. ,
Format: date-time ,
Required: False ,
}
string ,
nextRemindTime:
{
Description: The next remind time. ,
Format: date-time ,
Required: True ,
}
string ,
reminderSettings:
{
Description: The reminder settings. ,
Required: True ,
}
object ,
}
,
expiryInfo:
{
Description: Info of task expiry. ,
Required: False ,
}
{
lastExpiryNotificationTime:
{
Description: The last expiry notification time. ,
Format: date-time ,
Required: False ,
}
string ,
nextExpiryNotificationTime:
{
Description: The next expiry notification time. ,
Format: date-time ,
Required: True ,
}
string ,
expiryTime:
{
Description: The expiry time. ,
Format: date-time ,
Required: True ,
}
string ,
expirySettings:
{
Required: True ,
}
{
expireAfter:
{
Description: The time of expiry. ,
Required: True ,
}
object ,
notifyOnExpiration:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: True ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: True ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: True ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
ApproveApprovalTask (new)
Description :  Approve an approval task.
Reference :  Link ¶

⚼ Request

POST:  /workflowtasks/{taskId}/approve-approval
{
taskId:
{
Description: The task id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
approvalResponseComment:
{
Description: The request body of approving an approval request. ,
Required: True ,
}
{
comment:
{
Description: The comment of approving or rejecting an approval request. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: True ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: True ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: True ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
RejectApprovalTask (new)
Description :  Reject an approval task.
Reference :  Link ¶

⚼ Request

POST:  /workflowtasks/{taskId}/reject-approval
{
taskId:
{
Description: The task id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
approvalResponseComment:
{
Description: The request body of rejecting an approval request. ,
Required: True ,
}
{
comment:
{
Description: The comment of approving or rejecting an approval request. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: True ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: True ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: True ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
ReassignWorkflowTask (new)
Description :  Reassign a workflow task.
Reference :  Link ¶

⚼ Request

POST:  /workflowtasks/{taskId}/reassign
{
taskId:
{
Description: The task id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
reassignCommand:
{
Description: The request body of reassigning a workflow task. ,
Required: True ,
}
{
reassignments:
{
Description: The request body of reassigning a workflow task. ,
Required: False ,
}
[
{
reassignFrom:
{
Description: Reassign a workflow task from a user or a group. ,
Format: uuid ,
Required: True ,
}
string ,
reassignTo:
{
Description: Reassign a workflow task to a user or a group. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: True ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: True ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: True ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
UpdateTaskStatus (new)
Description :  Update the status of a workflow task request.
Reference :  Link ¶

⚼ Request

POST:  /workflowtasks/{taskId}/change-task-status
{
taskId:
{
Description: The task id. ,
Format: uuid ,
Required: True ,
}
string ,
taskUpdateCommand:
{
Description: Request body of updating workflow task request. ,
Required: True ,
}
{
newStatus:
{
Description: The new status will be used to update the task. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
comment:
{
Description: The comment when update a task. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: True ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: True ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: True ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}